feat: Add Homebrew formula update trigger to release workflow#121
feat: Add Homebrew formula update trigger to release workflow#121
Conversation
After publishing to PyPI, triggers the homebrew-deepwork repo to update the formula with the new version. Requires HOMEBREW_TAP_TOKEN secret with repo dispatch permissions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add brew tap/install as primary installation method in README - Add Homebrew to prerequisites in CONTRIBUTING guide Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds automated Homebrew formula updates as part of the release process, and documents Homebrew-based installation.
Changes:
- Add a post-PyPI publish job to dispatch an update event to the
homebrew-deepworktap repo. - Update README installation instructions to include Homebrew (tap + install).
- Mention Homebrew as an optional prerequisite for contributors.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
README.md |
Documents Homebrew installation steps alongside existing install options. |
CONTRIBUTING.md |
Adds Homebrew as an optional prerequisite for contributors. |
.github/workflows/release.yml |
Triggers a repository dispatch to update the Homebrew formula after PyPI publish. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Nix flakes enabled (add `experimental-features = nix-command flakes` to `~/.config/nix/nix.conf`) | ||
| - **direnv** (optional) - For automatic environment activation when using Nix flakes | ||
| - **uv** - Modern Python package installer (included in Nix environment) | ||
| - **Homebrew** (optional) - For easy installation on macOS/Linux via `brew install` |
There was a problem hiding this comment.
The prerequisite bullet lists Homebrew installation as brew install, but that command is incomplete without the formula name and tap (per README: brew tap unsupervisedcom/deepwork then brew install deepwork). Update this bullet to include the full command(s) so contributors can actually use it.
| - **Homebrew** (optional) - For easy installation on macOS/Linux via `brew install` | |
| - **Homebrew** (optional) - For easy installation on macOS/Linux via: | |
| - `brew tap unsupervisedcom/deepwork` | |
| - `brew install deepwork` |
| with: | ||
| token: ${{ secrets.DEPLOYER_CI_TOKEN }} | ||
| repository: Unsupervisedcom/homebrew-deepwork |
There was a problem hiding this comment.
PR description says the workflow requires a HOMEBREW_TAP_TOKEN secret, but the workflow actually uses secrets.DEPLOYER_CI_TOKEN. This mismatch will cause the job to fail (or require a different secret) and is confusing for maintainers. Align the workflow to use HOMEBREW_TAP_TOKEN or update the PR description (and any docs) to reference DEPLOYER_CI_TOKEN consistently.
After publishing to PyPI, triggers the homebrew-deepwork repo to update the formula with the new version.
Requires HOMEBREW_TAP_TOKEN secret with repo dispatch permissions.